<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: PMIC</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__syspm__functions__pmic.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">PMIC<div class="ingroups"><a class="el" href="group__group__syspm.html">SysPm        (System Power Management)</a> &raquo; <a class="el" href="group__group__syspm__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0a65826b5bbb61c785e3016dc4eff39b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga0a65826b5bbb61c785e3016dc4eff39b">Cy_SysPm_PmicEnable</a> (void)</td></tr>
<tr class="memdesc:ga0a65826b5bbb61c785e3016dc4eff39b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the external PMIC controller that supplies Vddd (if present).  <a href="#ga0a65826b5bbb61c785e3016dc4eff39b">More...</a><br /></td></tr>
<tr class="separator:ga0a65826b5bbb61c785e3016dc4eff39b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9cd99bbe881163eb76791e8474e4bbcb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga9cd99bbe881163eb76791e8474e4bbcb">Cy_SysPm_PmicDisable</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gac8cae3aa3e15bb4ce9e737fdaf5027fc">cy_en_syspm_pmic_wakeup_polarity_t</a> polarity)</td></tr>
<tr class="memdesc:ga9cd99bbe881163eb76791e8474e4bbcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the external PMIC controller that supplies Vddd (if present).  <a href="#ga9cd99bbe881163eb76791e8474e4bbcb">More...</a><br /></td></tr>
<tr class="separator:ga9cd99bbe881163eb76791e8474e4bbcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7cb78836a7fd272e1b3b1b76bf7917f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#gac7cb78836a7fd272e1b3b1b76bf7917f">Cy_SysPm_PmicAlwaysEnable</a> (void)</td></tr>
<tr class="memdesc:gac7cb78836a7fd272e1b3b1b76bf7917f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the external PMIC controller that supplies Vddd (if present) and force active.  <a href="#gac7cb78836a7fd272e1b3b1b76bf7917f">More...</a><br /></td></tr>
<tr class="separator:gac7cb78836a7fd272e1b3b1b76bf7917f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c6eadbd1e5f2ca43e959a1153aa8e3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga2c6eadbd1e5f2ca43e959a1153aa8e3a">Cy_SysPm_PmicEnableOutput</a> (void)</td></tr>
<tr class="memdesc:ga2c6eadbd1e5f2ca43e959a1153aa8e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the PMIC controller output pin.  <a href="#ga2c6eadbd1e5f2ca43e959a1153aa8e3a">More...</a><br /></td></tr>
<tr class="separator:ga2c6eadbd1e5f2ca43e959a1153aa8e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3110205ee0e5d422d3ec534953b6c0ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga3110205ee0e5d422d3ec534953b6c0ed">Cy_SysPm_PmicDisableOutput</a> (void)</td></tr>
<tr class="memdesc:ga3110205ee0e5d422d3ec534953b6c0ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the PMIC controller output pin.  <a href="#ga3110205ee0e5d422d3ec534953b6c0ed">More...</a><br /></td></tr>
<tr class="separator:ga3110205ee0e5d422d3ec534953b6c0ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b4ea274cd13069239a54244b343f625"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a> (void)</td></tr>
<tr class="memdesc:ga7b4ea274cd13069239a54244b343f625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks the PMIC control controller register so that no changes can be made.  <a href="#ga7b4ea274cd13069239a54244b343f625">More...</a><br /></td></tr>
<tr class="separator:ga7b4ea274cd13069239a54244b343f625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc9a1ba737ee1907cdb658c24ed90a6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a> (void)</td></tr>
<tr class="memdesc:gacc9a1ba737ee1907cdb658c24ed90a6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks the PMIC control register so that changes can be made.  <a href="#gacc9a1ba737ee1907cdb658c24ed90a6c">More...</a><br /></td></tr>
<tr class="separator:gacc9a1ba737ee1907cdb658c24ed90a6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16cd1f03066cbfbebcd936bc172820f1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga16cd1f03066cbfbebcd936bc172820f1">Cy_SysPm_PmicIsEnabled</a> (void)</td></tr>
<tr class="memdesc:ga16cd1f03066cbfbebcd936bc172820f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the status of the PMIC controller.  <a href="#ga16cd1f03066cbfbebcd936bc172820f1">More...</a><br /></td></tr>
<tr class="separator:ga16cd1f03066cbfbebcd936bc172820f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ba48bd0721a884c5b0c07114d5bb3ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga4ba48bd0721a884c5b0c07114d5bb3ee">Cy_SysPm_PmicIsOutputEnabled</a> (void)</td></tr>
<tr class="memdesc:ga4ba48bd0721a884c5b0c07114d5bb3ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the status of the PMIC controller output.  <a href="#ga4ba48bd0721a884c5b0c07114d5bb3ee">More...</a><br /></td></tr>
<tr class="separator:ga4ba48bd0721a884c5b0c07114d5bb3ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57dbfc7c1713ba6cea79bacddbd8d187"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__pmic.html#ga57dbfc7c1713ba6cea79bacddbd8d187">Cy_SysPm_PmicIsLocked</a> (void)</td></tr>
<tr class="memdesc:ga57dbfc7c1713ba6cea79bacddbd8d187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the PMIC controller lock status.  <a href="#ga57dbfc7c1713ba6cea79bacddbd8d187">More...</a><br /></td></tr>
<tr class="separator:ga57dbfc7c1713ba6cea79bacddbd8d187"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0a65826b5bbb61c785e3016dc4eff39b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a65826b5bbb61c785e3016dc4eff39b">&#9670;&nbsp;</a></span>Cy_SysPm_PmicEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicEnable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable the external PMIC controller that supplies Vddd (if present). </p>
<p>For information about the PMIC controller input and output pins and their assignment in specific devices, refer to the appropriate device TRM.</p>
<p>This function is not effective when the PMIC controller is locked. Call <a class="el" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c" title="Unlocks the PMIC control register so that changes can be made. ">Cy_SysPm_PmicUnlock()</a> before enabling the PMIC.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to enable the external PMIC while the PMIC </span></div><div class="line"><span class="comment">    *  controller is already locked</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga0a65826b5bbb61c785e3016dc4eff39b">Cy_SysPm_PmicEnable</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga9cd99bbe881163eb76791e8474e4bbcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9cd99bbe881163eb76791e8474e4bbcb">&#9670;&nbsp;</a></span>Cy_SysPm_PmicDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gac8cae3aa3e15bb4ce9e737fdaf5027fc">cy_en_syspm_pmic_wakeup_polarity_t</a>&#160;</td>
          <td class="paramname"><em>polarity</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable the external PMIC controller that supplies Vddd (if present). </p>
<p>This function does not affect the PMIC controller output pin. The PMIC controller input pin has programmable polarity to enable the external PMIC using different input polarities. The PMIC controller is automatically enabled when the input pin polarity and configured polarity match. This function is not effective when the active level of PMIC controller input pin is equal to the configured PMIC controller polarity.</p>
<p>The function is not effective when the PMIC controller is locked. Call <a class="el" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c" title="Unlocks the PMIC control register so that changes can be made. ">Cy_SysPm_PmicUnlock()</a> before enabling the PMIC controller.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polarity</td><td>Configures the PMIC controller wakeup input pin to be active low or active high. The PMIC will be automatically enabled when the set polarity and the active level of PMIC input pin match. See <a class="el" href="group__group__syspm__data__enumerates.html#gac8cae3aa3e15bb4ce9e737fdaf5027fc">cy_en_syspm_pmic_wakeup_polarity_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<p>The PMIC controller will be enabled automatically by any of RTC alarm or PMIC wakeup events, regardless of the PMIC controller lock state.</p>
<dl class="section note"><dt>Note</dt><dd>Before disabling the PMIC controller, ensure that PMIC input and PMIC output pins are configured correctly to enable expected PMIC operation.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The PMIC is enabled automatically when you call <a class="el" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625" title="Locks the PMIC control controller register so that no changes can be made. ">Cy_SysPm_PmicLock()</a>. To keep the external PMIC disabled, the PMIC controller must remain unlocked.</dd>
<dd>
Do not call Cy_SysPm_PmicDisable(CY_SYSPM_PMIC_POLARITY_LOW) because this is not supported by hardware.</dd></dl>
<p>For information about the PMIC controller input and output pins and their assignment in the specific devices, refer to the appropriate device TRM.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to disable the external PMIC with an active </span></div><div class="line"><span class="comment">    *  high state is detected on the PMIC controller input.</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the PMIC controller input pin to be active logic high after </span></div><div class="line"><span class="comment">    *  the PMIC controller is disabled</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga97e64dc8c45e7cd73e3012100d03b1fd">Cy_GPIO_SetDrivemode</a>(P0_4_PORT, P0_4_PIN, <a class="code" href="group__group__gpio__drive_modes.html#ga822f7d73072811b69a754d70806247b9">CY_GPIO_DM_PULLUP</a>);</div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga068ac50b08ea0a8ecff8c4e67f62208f">Cy_GPIO_Set</a>(P0_4_PORT, P0_4_PIN);</div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the PMIC controller output pin to be active logic low </span></div><div class="line"><span class="comment">    *  after the PMIC is disabled */</span></div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga97e64dc8c45e7cd73e3012100d03b1fd">Cy_GPIO_SetDrivemode</a>(P0_5_PORT, P0_5_PIN, <a class="code" href="group__group__gpio__drive_modes.html#gacebd8bea6222d742bdfbfd86dabab940">CY_GPIO_DM_STRONG_IN_OFF</a>);</div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#gacd73037c676059312d4dc794a32aec13">Cy_GPIO_Clr</a>(P0_5_PORT, P0_5_PIN);</div><div class="line">    </div><div class="line">    </div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__functions__pmic.html#ga4ba48bd0721a884c5b0c07114d5bb3ee">Cy_SysPm_PmicIsOutputEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#ga9cd99bbe881163eb76791e8474e4bbcb">Cy_SysPm_PmicDisable</a>(<a class="code" href="group__group__syspm__data__enumerates.html#ggac8cae3aa3e15bb4ce9e737fdaf5027fcad632c1c3db90572755db24b8cf14b4ff">CY_SYSPM_PMIC_POLARITY_HIGH</a>);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="gac7cb78836a7fd272e1b3b1b76bf7917f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac7cb78836a7fd272e1b3b1b76bf7917f">&#9670;&nbsp;</a></span>Cy_SysPm_PmicAlwaysEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicAlwaysEnable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable the external PMIC controller that supplies Vddd (if present) and force active. </p>
<p>This is a Write once API. It ensures that the PMIC controller cannot be disabled or polarity changed until a next device reset.</p>
<p>For information about the PMIC controller input and output pins and their assignment in the specific devices, refer to the appropriate device TRM.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to enable the signal through the PMIC </span></div><div class="line"><span class="comment">    *  controller output pin</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#gac7cb78836a7fd272e1b3b1b76bf7917f">Cy_SysPm_PmicAlwaysEnable</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga2c6eadbd1e5f2ca43e959a1153aa8e3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c6eadbd1e5f2ca43e959a1153aa8e3a">&#9670;&nbsp;</a></span>Cy_SysPm_PmicEnableOutput()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicEnableOutput </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the PMIC controller output pin. </p>
<p>The function is not effective when the PMIC controller is locked. Call <a class="el" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c" title="Unlocks the PMIC control register so that changes can be made. ">Cy_SysPm_PmicUnlock()</a> before enabling the PMIC controller.</p>
<p>For information about the PMIC controller output pin and its assignment in specific devices, refer to the appropriate device TRM.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to enable the PMIC controller output.</span></div><div class="line"><span class="comment">    * Note that the output logic state of the pmic_output is ignored once </span></div><div class="line"><span class="comment">    * the Cy_SysPm_PmicEnableOutput() is called.</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga2c6eadbd1e5f2ca43e959a1153aa8e3a">Cy_SysPm_PmicEnableOutput</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga3110205ee0e5d422d3ec534953b6c0ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3110205ee0e5d422d3ec534953b6c0ed">&#9670;&nbsp;</a></span>Cy_SysPm_PmicDisableOutput()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicDisableOutput </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the PMIC controller output pin. </p>
<p>When the PMIC controller output pin is disabled and is unlocked, the PMIC controller output pin can be used for the another purpose.</p>
<p>The function has no effect when the PMIC is locked. Call <a class="el" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c" title="Unlocks the PMIC control register so that changes can be made. ">Cy_SysPm_PmicUnlock()</a> before enabling the PMIC.</p>
<p>For information about the PMIC controller output pin and its assignment in specific devices, refer to the appropriate device TRM.</p>
<dl class="section note"><dt>Note</dt><dd>After the PMIC controller output is disabled, the PMIC output pin returns to its GPIO configured state.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The PMIC controller output is enabled automatically when you call <a class="el" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625" title="Locks the PMIC control controller register so that no changes can be made. ">Cy_SysPm_PmicLock()</a>. To keep the PMIC controller output disabled, the PMIC controller must remain unlocked.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to disable the PMIC controller output. Note </span></div><div class="line"><span class="comment">    *  that once the Cy_SysPm_PmicDisableOutput() is called, the pmic_output pin</span></div><div class="line"><span class="comment">    *  returns to its GPIO configuration.</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the pmic_output pin GPIO configuration to Strong Drive, Input </span></div><div class="line"><span class="comment">    * buffer off and have output active logic state low. This GPIO configuration</span></div><div class="line"><span class="comment">    * applies after Cy_SysPm_PmicDisableOutput() is called.</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga97e64dc8c45e7cd73e3012100d03b1fd">Cy_GPIO_SetDrivemode</a>(P0_5_PORT, P0_5_PIN, <a class="code" href="group__group__gpio__drive_modes.html#gacebd8bea6222d742bdfbfd86dabab940">CY_GPIO_DM_STRONG_IN_OFF</a>);</div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#gacd73037c676059312d4dc794a32aec13">Cy_GPIO_Clr</a>(P0_5_PORT, P0_5_PIN);</div><div class="line">    </div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga3110205ee0e5d422d3ec534953b6c0ed">Cy_SysPm_PmicDisableOutput</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga7b4ea274cd13069239a54244b343f625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b4ea274cd13069239a54244b343f625">&#9670;&nbsp;</a></span>Cy_SysPm_PmicLock()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicLock </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Locks the PMIC control controller register so that no changes can be made. </p>
<p>The changes are related to PMIC enabling/disabling and PMIC output pin enabling/disabling.</p>
<dl class="section warning"><dt>Warning</dt><dd>The PMIC controller and/or the PMIC output are enabled automatically when you call <a class="el" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625" title="Locks the PMIC control controller register so that no changes can be made. ">Cy_SysPm_PmicLock()</a>. To keep the PMIC or PMIC controller output disabled, the PMIC controller must remain unlocked.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to lock and enable the PMIC controller */</span></div><div class="line">    <span class="keywordflow">if</span> (!<a class="code" href="group__group__syspm__functions__pmic.html#ga57dbfc7c1713ba6cea79bacddbd8d187">Cy_SysPm_PmicIsLocked</a>() &amp;&amp; <a class="code" href="group__group__syspm__functions__pmic.html#ga16cd1f03066cbfbebcd936bc172820f1">Cy_SysPm_PmicIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a>();</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="gacc9a1ba737ee1907cdb658c24ed90a6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacc9a1ba737ee1907cdb658c24ed90a6c">&#9670;&nbsp;</a></span>Cy_SysPm_PmicUnlock()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_PmicUnlock </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unlocks the PMIC control register so that changes can be made. </p>
<p>The changes are related to the PMIC controller enabling/disabling and PMIC output pin enabling/disabling.</p>
<dl class="section warning"><dt>Warning</dt><dd>The PMIC controller and/or the PMIC output are enabled automatically when you call <a class="el" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625" title="Locks the PMIC control controller register so that no changes can be made. ">Cy_SysPm_PmicLock()</a>. To keep the PMIC controller or PMIC output disabled, the PMIC must remain unlocked.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to enable the external PMIC while the PMIC </span></div><div class="line"><span class="comment">    *  controller is already locked</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga0a65826b5bbb61c785e3016dc4eff39b">Cy_SysPm_PmicEnable</a>();</div><div class="line">    <a class="code" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga16cd1f03066cbfbebcd936bc172820f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga16cd1f03066cbfbebcd936bc172820f1">&#9670;&nbsp;</a></span>Cy_SysPm_PmicIsEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_PmicIsEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the status of the PMIC controller. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>True if the PMIC is enabled.</li>
<li>False if the PMIC is disabled.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to lock and enable the PMIC controller */</span></div><div class="line">    <span class="keywordflow">if</span> (!<a class="code" href="group__group__syspm__functions__pmic.html#ga57dbfc7c1713ba6cea79bacddbd8d187">Cy_SysPm_PmicIsLocked</a>() &amp;&amp; <a class="code" href="group__group__syspm__functions__pmic.html#ga16cd1f03066cbfbebcd936bc172820f1">Cy_SysPm_PmicIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a>();</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga4ba48bd0721a884c5b0c07114d5bb3ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ba48bd0721a884c5b0c07114d5bb3ee">&#9670;&nbsp;</a></span>Cy_SysPm_PmicIsOutputEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_PmicIsOutputEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the status of the PMIC controller output. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>True if the PMIC output is enabled.</li>
<li>False if the PMIC output is disabled.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to disable the external PMIC with an active </span></div><div class="line"><span class="comment">    *  high state is detected on the PMIC controller input.</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the PMIC controller input pin to be active logic high after </span></div><div class="line"><span class="comment">    *  the PMIC controller is disabled</span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga97e64dc8c45e7cd73e3012100d03b1fd">Cy_GPIO_SetDrivemode</a>(P0_4_PORT, P0_4_PIN, <a class="code" href="group__group__gpio__drive_modes.html#ga822f7d73072811b69a754d70806247b9">CY_GPIO_DM_PULLUP</a>);</div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga068ac50b08ea0a8ecff8c4e67f62208f">Cy_GPIO_Set</a>(P0_4_PORT, P0_4_PIN);</div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the PMIC controller output pin to be active logic low </span></div><div class="line"><span class="comment">    *  after the PMIC is disabled */</span></div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#ga97e64dc8c45e7cd73e3012100d03b1fd">Cy_GPIO_SetDrivemode</a>(P0_5_PORT, P0_5_PIN, <a class="code" href="group__group__gpio__drive_modes.html#gacebd8bea6222d742bdfbfd86dabab940">CY_GPIO_DM_STRONG_IN_OFF</a>);</div><div class="line">    <a class="code" href="group__group__gpio__functions__gpio.html#gacd73037c676059312d4dc794a32aec13">Cy_GPIO_Clr</a>(P0_5_PORT, P0_5_PIN);</div><div class="line">    </div><div class="line">    </div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__functions__pmic.html#ga4ba48bd0721a884c5b0c07114d5bb3ee">Cy_SysPm_PmicIsOutputEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#gacc9a1ba737ee1907cdb658c24ed90a6c">Cy_SysPm_PmicUnlock</a>();</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#ga9cd99bbe881163eb76791e8474e4bbcb">Cy_SysPm_PmicDisable</a>(<a class="code" href="group__group__syspm__data__enumerates.html#ggac8cae3aa3e15bb4ce9e737fdaf5027fcad632c1c3db90572755db24b8cf14b4ff">CY_SYSPM_PMIC_POLARITY_HIGH</a>);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga57dbfc7c1713ba6cea79bacddbd8d187"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57dbfc7c1713ba6cea79bacddbd8d187">&#9670;&nbsp;</a></span>Cy_SysPm_PmicIsLocked()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_PmicIsLocked </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the PMIC controller lock status. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>True if the PMIC is locked.</li>
<li>False if the PMIC is unlocked.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to lock and enable the PMIC controller */</span></div><div class="line">    <span class="keywordflow">if</span> (!<a class="code" href="group__group__syspm__functions__pmic.html#ga57dbfc7c1713ba6cea79bacddbd8d187">Cy_SysPm_PmicIsLocked</a>() &amp;&amp; <a class="code" href="group__group__syspm__functions__pmic.html#ga16cd1f03066cbfbebcd936bc172820f1">Cy_SysPm_PmicIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__syspm__functions__pmic.html#ga7b4ea274cd13069239a54244b343f625">Cy_SysPm_PmicLock</a>();</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) &amp; CAT1C devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
